Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidied up breadcrumbs file #185

Merged
merged 5 commits into from
Feb 28, 2023
Merged

Tidied up breadcrumbs file #185

merged 5 commits into from
Feb 28, 2023

Conversation

javabster
Copy link
Collaborator

@javabster javabster commented Feb 23, 2023

fixes #114

In this PR:

  • After discussion in one of our meetings we decided to remove the code button from the breadcrumbs (which is why most of the jinja logic in the file is now gone). This decision was made because qiskit projects already provide a link to the source code from the individual class/functions so it wasn't adding much value. There is an issue open (Help projects use sphinx.ext.linkcode so that source code links to GitHub #186 ) for further work on improving the source code links
  • adjusted the CSS styling of the breadcrumbs box so the long text (3 lines or more) doesn't overflow the breadcrumbs box

before:
Screenshot 2023-02-23 at 4 18 32 PM

after:
Screenshot 2023-02-23 at 3 58 40 PM

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Comment on lines -33 to -35
{% if theme_pytorch_project == 'tutorials' %}
Tutorials
{% else %}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What was this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this was a holdover from when the Tutorials were built using a separate process from the main package? Or it's possible it was just copied over from pytorch, because I don't remember seeing the theme_pytorch_project variable anywhere in our codebases.

Copy link
Contributor

@HuangJunye HuangJunye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for cleaning up the breadcrumbs! While I like that the button got removed, I prefer the spacing above and below the breadcrumb before the change. Not sure if this is related to solving the issue of long breadcrumb you mentioned in the description. It would be great if we can solve that issue while still maintain the spacing.

Before
Screenshot 2023-02-27 at 15 26 54

After
Screenshot 2023-02-27 at 15 26 51

@javabster javabster merged commit 2b5ced2 into Qiskit:main Feb 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Review and Refactor breadcrumbs.html
3 participants